Prettier pre commit hook #419
Conversation
There was a problem hiding this comment.
I feel like we should discuss what convention we actually use before implementing something like this (and which linter we use for that matter).
Is prettier setup to use the editorconfig file as rules? I can't see where this setting is enabled, and if not why is the prettierrc file empty?
I disagree with the 2-space indentation, and feel like there are other things we should consider linting for such as single our double quotation marks for strings. Might be worth discussing this outside of a github pull request
|
Can add that I believe we elected (then immediately forgot) to use Airbnb's style convention when we did our bachelor thesis work |
|
Prettier automatically uses some of the rules in editorconfig if it detects an editorconfig file. The editorconfig file also sets up the editor to use the correct settings from the start. The reason the .prettierrc.json file is empty is because prettier recommends that the file exists even though it has no configuration since it can let other tools know that we are using prettier. The nice thing about prettier is that it's default formatting rules makes the code readable and avoids long lines without having to decide on each rule it has. Having 2 spaces as indentation is very common in React apps since most JSX functions tend to become very nested which makes them difficult to read, having only 2 spaces helps out with that issue |
|
We will implement Airbnb's style with Eslint before adding the prettier pre-commit hook |
| . "$(dirname -- "$0")/_/husky.sh" | ||
|
|
||
| cd frontend | ||
| npx lint-staged |
There was a problem hiding this comment.
| npx lint-staged | |
| yarn lint-staged |
We should use yarn instead of npx.
| "prepare": "cd .. && husky install frontend/.husky" | ||
| }, | ||
| "lint-staged": { | ||
| "**/*": "prettier --write --ignore-unknown" |
There was a problem hiding this comment.
When implementing ESLint, a pre-commit hook should be added for ESLint.
This PR sets up a prettier pre commit hook. Everytime a commit is made, the pre hook will automatically format all files that have been staged in the commit so that the code always gets formatted even if someone hasn't installed prettier in their editor
I will make a separate PR that will format all existing code to the prettier configuration once this PR has been merged
Closes #386